docs: comprehensive documentation review & update (all 7 waves)#961
Open
Cataldir wants to merge 4 commits into
Open
docs: comprehensive documentation review & update (all 7 waves)#961Cataldir wants to merge 4 commits into
Cataldir wants to merge 4 commits into
Conversation
- Wave 1: Business scenarios rewritten with agentic vs traditional comparisons, stakeholder maps, NFRs, and bounded context documentation - Wave 2: Architecture docs and 27 ADRs updated with correct service counts, Mermaid themes, and current deployment topology - Wave 3: Sequence diagrams and diagram index updated with standard themes, prose captions, and accurate flow data - Wave 4: Framework lib README, 26 agent READMEs standardized with consistent template, apps/README rewritten with domain groupings - Wave 5: UI README fully rewritten with route map, component architecture, agent overlay system, and API client docs - Wave 6: Governance, ops runbooks, roadmap, and CONTRIBUTING updated with current namespace refs, date stamps, and deployment procedures - Wave 7: Root README enhanced with platform-at-a-glance table, audience-based navigation, and docs hub reorganized as navigation index Closes #960
- Add curl-examples.sh with API calls for all 26 agents + CRUD - Add powershell-examples.ps1 (Windows equivalent) - Add load-kaggle-olist-dataset.py: downloads Brazilian E-Commerce (Olist) dataset from Kaggle, transforms to CRUD schema, seeds via REST API (CC BY-NC-SA 4.0, async httpx + pandas) - Complete order-fulfillment.md with full 8-step SAGA choreography demo - Complete crm-campaigns.md with full 5-step campaign lifecycle demo - Update agent-playgrounds/README.md to reference interactive scenarios Ref #960
- Move curl-examples.sh and powershell-examples.ps1 from docs/demos/api-examples/ to scripts/demos/ - Create scripts/demos/README.md with usage and prerequisites - Update docs/demos/README.md: new Quick Navigation table, Scripts & Tools section, Data Sources section, fix Phase 1 reference - Update docs/demos/api-examples/README.md: link to new script locations + Kaggle loader - Update docs/demos/sample-data/README.md: add Kaggle Olist section - Update docs/README.md: add Scripts row in documentation index
Restructure scripts/ from purpose-based (ci/ops/demos) to language-based hierarchy with purpose as second level: scripts/python/ci/ - CI validation gates (6 scripts) scripts/python/ops/ - Operational Python (7 scripts) scripts/powershell/ops/ - Operational PowerShell (8 scripts) scripts/powershell/demos/ - Demo PowerShell (1 script) scripts/shell/ops/ - Operational Bash (3 scripts) scripts/shell/demos/ - Demo Bash (1 script) Updated all references in: - 4 GitHub Actions workflows (deploy-azd, lint, governance-audit, ui-contract-gate) - .githooks/pre-push - pre_push_gate.py (self-references) - 8 documentation files (CONTRIBUTING, docs/README, governance, demos, ops, etc.) - Python script docstrings (usage comments) - .github/skills/agent-e2e-validation/SKILL.md CHANGELOG.md historical entries intentionally left unchanged.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Comprehensive documentation review across 113 files in 7 waves. Updates business scenarios, architecture, ADRs, diagrams, agent READMEs, UI docs, governance, ops, and root README. All Mermaid themes standardized, dates to 2026-04-30, service counts corrected. Closes #960